/*
 * ProGuard -- shrinking, optimization, obfuscation, and preverification of Java bytecode.
 *
 * Copyright (c) 2002-2018 GuardSquare NV
 *
 * This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this program; if not, write to the Free
 * Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */
package proguard.evaluation.value;

import proguard.classfile.Clazz;

/**
 * This interface provides methods to create Value objects.
 *
 * @author Eric Lafortune
 */
public interface ValueFactory {
    /**
     * Creates a new Value of the given type. The type must be a fully specified internal type for primitives, classes,
     * or arrays.
     */
    public Value createValue(String type, Clazz referencedClass, boolean mayBeExtension, boolean mayBeNull);

    /**
     * Creates a new IntegerValue with an undefined value.
     */
    public IntegerValue createIntegerValue();

    /**
     * Creates a new IntegerValue with a given particular value.
     */
    public IntegerValue createIntegerValue(int value);

    /**
     * Creates a new LongValue with an undefined value.
     */
    public LongValue createLongValue();

    /**
     * Creates a new LongValue with a given particular value.
     */
    public LongValue createLongValue(long value);

    /**
     * Creates a new FloatValue with an undefined value.
     */
    public FloatValue createFloatValue();

    /**
     * Creates a new FloatValue with a given particular value.
     */
    public FloatValue createFloatValue(float value);

    /**
     * Creates a new DoubleValue with an undefined value.
     */
    public DoubleValue createDoubleValue();

    /**
     * Creates a new DoubleValue with a given particular value.
     */
    public DoubleValue createDoubleValue(double value);

    /**
     * Creates a new ReferenceValue of an undefined type.
     */
    public ReferenceValue createReferenceValue();

    /**
     * Creates a new ReferenceValue that represents <code>null</code>.
     */
    public ReferenceValue createReferenceValueNull();

    /**
     * Creates a new ReferenceValue that represents the given type. The type must be an internal class name or an array
     * type. If the type is <code>null</code>, the ReferenceValue represents <code>null</code>.
     */
    public ReferenceValue createReferenceValue(String type, Clazz referencedClass, boolean mayBeExtension,
        boolean mayBeNull);

    /**
     * Creates a new ReferenceValue that represents a non-null array with elements of the given type, with the given
     * length.
     */
    public ReferenceValue createArrayReferenceValue(String type, Clazz referencedClass, IntegerValue arrayLength);

    /**
     * Creates a new ReferenceValue that represents a non-null array with elements of the given type, with the given
     * length and initial element values.
     */
    public ReferenceValue createArrayReferenceValue(String type, Clazz referencedClass, IntegerValue arrayLength,
        Value elementValue);
}
